<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Functions  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/objc/Section/Functions" class="dashAnchor"></a>
    <a title="Functions  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">OHMySQL Docs</a> (89% documented)</p>
        <p class="header-right"><a href="https://github.com/oleghnidets/OHMySQL"><img src="img/gh.png"/>View on GitHub</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">OHMySQL Reference</a>
        <img id="carat" src="img/carat.png" />
        Functions  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Categories.html">Categories</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Categories/NSObject(Mapping).html">NSObject(Mapping)</a>
              </li>
              <li class="nav-group-task">
                <a href="Categories/NSString(Escaping).html">NSString(Escaping)</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Classes/OHMySQLContainer.html">OHMySQLContainer</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLQueryContext.html">OHMySQLQueryContext</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLQueryRequest.html">OHMySQLQueryRequest</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLQueryRequestFactory.html">OHMySQLQueryRequestFactory</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLStore.html">OHMySQLStore</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLStoreCoordinator.html">OHMySQLStoreCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLTimeline.html">OHMySQLTimeline</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHMySQLUser.html">OHMySQLUser</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/OHSSLConfig.html">OHSSLConfig</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Constants.html">Constants</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Constants.html#/c:@OHJoinFull">OHJoinFull</a>
              </li>
              <li class="nav-group-task">
                <a href="Constants.html#/c:@OHJoinInner">OHJoinInner</a>
              </li>
              <li class="nav-group-task">
                <a href="Constants.html#/c:@OHJoinLeft">OHJoinLeft</a>
              </li>
              <li class="nav-group-task">
                <a href="Constants.html#/c:@OHJoinRight">OHJoinRight</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/CharsetEncoding.html">CharsetEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/OHProtocolType.html">OHProtocolType</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/OHRefreshOptions.html">OHRefreshOptions</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/OHResultErrorType.html">OHResultErrorType</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Protocols/OHMappingProtocol.html">OHMappingProtocol</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Functions.html">Functions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Functions.html#/c:@F@MySQLCharsetForEncoding">MySQLCharsetForEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="Functions.html#/c:@F@NSStringEncodingFromCharsetEncoding">NSStringEncodingFromCharsetEncoding</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Functions</h1>
            <p>The following functions are available globally.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:@F@MySQLCharsetForEncoding"></a>
                    <a name="//apple_ref/objc/Function/MySQLCharsetForEncoding" class="dashAnchor"></a>
                    <a class="token" href="#/c:@F@MySQLCharsetForEncoding">MySQLCharsetForEncoding</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Parses input parameters and returns appropriate character set string.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="n">MySQLCharsetForEncoding</span><span class="p">(</span><span class="n"><a href="Enums/CharsetEncoding.html">CharsetEncoding</a></span> <span class="n">encoding</span><span class="p">)</span></code></pre>

                        </div>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="kt">MySQLCharsetForEncoding</span><span class="p">(</span><span class="n">_</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt"><a href="Enums/CharsetEncoding.html">CharsetEncoding</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>encoding</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Defined OHMySQL encoding to use.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Name of the encoding. The behavior is undefined if an invalid string encoding is passed.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:@F@NSStringEncodingFromCharsetEncoding"></a>
                    <a name="//apple_ref/objc/Function/NSStringEncodingFromCharsetEncoding" class="dashAnchor"></a>
                    <a class="token" href="#/c:@F@NSStringEncodingFromCharsetEncoding">NSStringEncodingFromCharsetEncoding</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Converts library&rsquo; encoding to the Cocoa encoding.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="n">NSStringEncoding</span> <span class="n">NSStringEncodingFromCharsetEncoding</span><span class="p">(</span><span class="n"><a href="Enums/CharsetEncoding.html">CharsetEncoding</a></span> <span class="n">encoding</span><span class="p">)</span></code></pre>

                        </div>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="kt">NSStringEncodingFromCharsetEncoding</span><span class="p">(</span><span class="n">_</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt"><a href="Enums/CharsetEncoding.html">CharsetEncoding</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">UInt</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>encoding</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Defined OHMySQL encoding to use.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The Cocoa encoding (of type NSStringEncoding) that is closest to the Core Foundation encoding encoding. The behavior is undefined if an invalid string encoding is passed.</p>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2018 <a class="link" href="https://github.com/oleghnidets" target="_blank" rel="external">Oleg</a>. All rights reserved. (Last updated: 2018-05-02)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
